home *** CD-ROM | disk | FTP | other *** search
/ Whiteline: Alpha / Whiteline Alpha.iso / tools / grepit / grepit.hlp < prev    next >
Encoding:
Text File  |  1994-09-22  |  35.5 KB  |  1,053 lines

  1.  
  2.  
  3.     ≡TABLE OF CONTENTS≡
  4.  
  5.  
  6.  
  7.     ≡INSTALLATION≡
  8.       Disclaimer
  9.       As an accessory
  10.     As a GEM program
  11.  
  12.     ≡ABOUT GREPIT≡
  13.       Overview
  14.     Support
  15.     Credits
  16.  
  17.     ≡GETTING STARTED≡
  18.       As an accessory
  19.     As a GEM program
  20.  
  21.     ≡USE OF DIALOG BOXES≡
  22.  
  23.     ≡USE OF OUTPUT WINDOW≡
  24.  
  25.     ≡THE MAIN DIALOG≡
  26.       Source(s)
  27.     Destination
  28.     Expression
  29.     Options
  30.     The Popups (The history function)
  31.  
  32.     ≡'EXTENDED OPTIONS' DIALOG≡
  33.  
  34.     ≡'SETTINGS' DIALOG≡
  35.  
  36.     ≡'FONT' DIALOG≡
  37.  
  38.     ≡'COLORS' DIALOG≡
  39.  
  40.     ≡'FIND' DIALOG≡
  41.  
  42.     ≡'MARK EXPRESSION' DIALOG≡
  43.  
  44.     ≡'PRINTER SETTINGS' DIALOG≡
  45.  
  46.     ≡'PRINT' DIALOG≡
  47.  
  48.     ≡REGULAR EXPRESSIONS≡
  49.  
  50.     ≡SPECIAL FEATURES≡
  51.       Messages from GREPIT to other programs
  52.     Messages from other programs to GREPIT
  53.  
  54.     ≡EXAMPLES, TIPS AND TRICKS≡
  55.       Converting to and from UNIX
  56.     Extracting of strings or comments
  57.     Search by using expression files (lists)
  58.     GREPIT as a file finder
  59.  
  60.     ≡KEYBOARD SHORTCUTS≡
  61.  
  62.     ≡HELP ON HELP≡
  63.  
  64.     ≡GETTING REGISTERED≡
  65.  
  66.  
  67. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  68.  
  69.  
  70. ≡INSTALLATION≡
  71.  
  72.  
  73. ∙Disclaimer∙
  74.  
  75. MicroService H. Wierl makes no representation or warranty with respect
  76. to the adequacy of this documentation or the programs which it describes
  77. for any particular purpose or with respect to its adequacy to produce
  78. any particular result. In no event shall MicroService H. Wierl be
  79. liable for special, direct, indirect or consequentional damages, losses,
  80. costs, charges, claims, demands, or claim for lost profits, fees or
  81. expenses of any nature or kind.
  82.  
  83.  
  84. You need, at least, the following files to work with GREPIT:
  85.  
  86.     GREPIT.ACC (or GREPIT.PRG or GREPIT.APP)
  87.     GREPIT.RSC
  88.     GREPIT.HLP
  89.     
  90. If there's no GREPIT.HLP there's no help period! Got it? Good ...
  91.  
  92. Just put the three files together in the one (sub-)directory, because
  93. GREPIT loads them from the same directory where it started from. GREPIT
  94. automatically recognizes whether it is an accessory or a normal program.
  95. On Atari TT-models, the TT-Ram-Bits in the program header can (should)
  96. be set for maximum performance (i.e. warp 9.9).
  97.  
  98.  
  99. ∙As an Accessory∙
  100.  
  101. Copy GREPIT.PRG (with GREPIT.RSC and GREPIT.HLP of course) to the root
  102. directory of your boot partition and rename it to GREPIT.ACC.
  103.  
  104.  
  105. ∙As a GEM Program∙
  106.  
  107. You may copy GREPIT to whatever (sub-)directory you like. Use .PRG or
  108. .APP for the extension.
  109.  
  110.  
  111. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  112.  
  113.  
  114. ≡ABOUT GREPIT≡
  115.  
  116.  
  117. ∙Overview∙
  118.  
  119. The program GREPIT is used for pattern matching and string searching in
  120. files. Through the use of regular expressions GREPIT can provide you
  121. with search patterns however complex they may be. These patterns can be
  122. searched for in all types of files.
  123.  
  124. GREPIT also provides you with many options to vary or specify search
  125. and output. GREPIT is a powerful tool mainly for those who deal with
  126. many texts, as in the fields of software development or electronic mail
  127. /communication etc.
  128.  
  129. GREPIT reads files line by line and searches for the pattern. Lines
  130. with possible matches are shown in the output window and written to
  131. the specified output file.
  132.  
  133. GREPIT lets you easily jump into (and back) the found files just by
  134. clicking on a file path or line number in the output window.
  135.  
  136. GREPIT is (or will soon be) available for various platforms in addition
  137. to Atari TOS as MS-DOS, MS Windows, Windows NT, OS/2, NeXTstep, Apple,
  138. Unix ...
  139.  
  140. HINT! Don't be surprised if the pattern you are searching for is not
  141. found on the first try. Be especially careful when using regular
  142. expressions, for the outcome may be unexpected!
  143.  
  144. Please thoroughly analyze your search pattern and the outcoming line,
  145. before you verbally abuse GREPIT. Ha Ha ...
  146.  
  147. But! If by chance GREPIT misinterprets a regular expression, please
  148. advise us of this and or any other malfunction (hopefully not ;-)).
  149.  
  150. Many "extras" are featured in this warp speed fast, 110% reliable,  
  151. schwarzenegger powerful and easy to relate to, grep utility. But sorry
  152. dude, you must consult this help function from the beginning to the
  153. bitter end to know what the hell we are talking about! So read on and
  154. we'll make it entertaining. It's worth it, believe us ...
  155.  
  156.  
  157. ∙Support∙
  158.  
  159. Full support is available to registered users only. Please tell us
  160. your serial number when contacting us with questions or problems.
  161. Error reports or suggestions are welcome.
  162.  
  163. Our adress is:
  164.  
  165.         MicroService Hermann Wierl
  166.         Bahnhofstrasse 8
  167.         93336 Altmannstein
  168.         GERMANY
  169.         MO-FR 9-12 a.m. and 2-5 p.m. CET
  170.  
  171.         Phone and FAX:  +49-9446-2149
  172.         E-Mail: CompuServe 100345,2231
  173.  
  174. The latest version of GREPIT is periodically uploaded to CompuServe
  175. (ATARIPRO forum, Library #3 "Programming Tools" and Library #4 "Utility
  176. Programs") and can also be requested at Fido Node 2:2494/315 (Support
  177. BBS, Phone +49-9405-7278).
  178.  
  179. The archive filenames are should normally be:
  180.   GREPIT.LZH  for Atari TOS          (german and english),
  181.   GREPIT.ARJ  for MS-DOS             (   "    "     "    ),
  182.   GREPIT.ZIP  for Windows/Windows NT (   "    "     "    ).
  183.   
  184. The authors can also be contacted via private E-Mail adresses:
  185.   Hermann Wierl @ R          (MausNet Germany),
  186.   Hermann Wierl @ 2:2494/315 (FidoNet),
  187. which look like this as Internet adresses:
  188.   hermann_wierl@r.maus.de
  189.   hermann_wierl@f315.n2494.z2.fidonet.org
  190.  
  191.  
  192. ∙Credits∙
  193.  
  194. Special Thanx to:
  195.  
  196.   Rita Bergbauer, for the everything-except-computer-support for one
  197.   half of the author team,
  198.   Alison Easton, for English language support and the above mentioned
  199.   for the second half of the author team as well as 
  200.   explaining some Beavis and Butthead jokes ;-),
  201.   Hermann Weindl, for permanent puzzling over algorithms,
  202.   Max Heinzlmeir, for his patience in never ending beta tests,
  203.   Gerhard and Martin Huber of Computerislands Bad Gogging for their
  204.   fantastic NOVA graphic cards.
  205.  
  206. Bug reports (especially if you live in Florida - we know how big those
  207. bugs can get) and suggestions for future improvements are welcome and
  208. appreciated! So don't be shy...
  209.  
  210.  
  211. That's all folks. C-ya! Wouldn't wanna B-ya!
  212.  
  213.  
  214. Wolfgang Schamberger                                   Hermann Wierl
  215.  
  216.  
  217. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  218.  
  219.  
  220. ≡GETTING STARTED≡
  221.  
  222.  
  223. ∙As an Accessory∙
  224.  
  225. Choose "Grepit" in the accessory menu. Oooops! Of course... duh!
  226. I kill me!
  227.  
  228.  
  229. ∙As a GEM Program∙
  230.  
  231. Like every other program you start GREPIT by double clicking on the
  232. icon or the program name on your desktop. Did you expect something
  233. else? Sorry, couldn't resist... a duh!
  234.  
  235. Did I forget to mention that you first must switch on your computer?
  236. Ok, let's forget this chapter and continue on...
  237.  
  238.  
  239. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  240.  
  241.  
  242. ≡USE OF DIALOG BOXES≡
  243.  
  244.  
  245. Most aspects of dialog boxes can be used also with keyboard. If there is
  246. an underlined character in a selectable object, just press "Alternate"
  247. along with this character. Exceptions to this rule are the [Cancel]
  248. button, which can be activated by the "Undo" key, and the [?] button
  249. which corresponds with the "Help" key.
  250.  
  251. Since dialog boxes are shown in windows, they are moveable like windows.
  252. Clean 'em from time to time and don't break 'em! (I know, I know, I 
  253. don't do windows!)
  254.  
  255. Edit Fields
  256.  
  257. You can place the cursor into each edit field by clicking the left mouse
  258. button, using the Up/Down arrow keys or the combination Tab/Shift-Tab.
  259.  
  260.  
  261. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  262.  
  263.  
  264. ≡USE OF OUTPUT WINDOW≡
  265.  
  266.  
  267. It is a standard GEM-Window, which also can be used with the keyboard:
  268.  
  269.     Arrow up                        :        scroll up
  270.     Arrow down                    :        scroll down
  271.     Arrow right                    :        scroll right
  272.     Arrow left                    :        scroll left
  273.     Shift and arrow keys:        page scroll
  274.     ClrHome                            :        beginning of the file
  275.     Shift-ClrHome                :        end of the file
  276.     Control-ClrHome            :        adjust window size to maximum and back
  277.     Control-F                        :        find expression in window
  278.     Control-G                        :     repeat find
  279.     Control-P                        :     print file
  280.     Control-U                        :     close window
  281.  
  282.  
  283. Special features:
  284.  
  285. Double click (left mouse button) on a complete file path:
  286.     GREPIT displays this file.
  287. Double click (left mouse button) on a line number:
  288.     GREPIT displays this file beginning with this line.
  289.  
  290. If the double click is neither on a file path nor on a line number,
  291. basically you 're not in Kansas anymore Dorothy! But, GREPIT will
  292. help you out by displaying the "Find" dialog.
  293.  
  294. You return to the previous file either by double clicking the right
  295. mouse button or the "Undo" key. There's no place like home!
  296.  
  297. Brackets surrounding the file path in the window title notify you
  298. of reading a subfile not the main file, use this as a reminder.
  299.  
  300. The above features mentioned can only be used in the main file, not
  301. (yet) in a subfile.
  302.  
  303. If our shell M>DESK is acivated, you can drag a file from any M>DESK
  304. window and drop it onto the GREPIT window and GREPIT will display the
  305. file. Double clicking on a file path in GREPIT with the right mouse
  306. button passes this file to M>DESK. Other protocolls will be implemented
  307. upon demand.
  308.  
  309.  
  310. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  311.  
  312.  
  313. ≡THE MAIN DIALOG≡
  314.  
  315.  
  316. This dialog is the actual center of GREPIT. Here the search process
  317. starts after the input of source, destination and expression. History
  318. popups and the most important options are available here. Batteries
  319. not included!
  320.  
  321.  
  322. ∙Source(s)∙
  323.  
  324. You have the following possibilities to specify the source files:
  325.  
  326.     C:\DIR\FILE.EXT        :    The file C:\DIR\FILE.EXT is used for search.
  327.     
  328.     C:\DIR\*.EXT            :    All files in the directory C:\DIR with the
  329.                         extension .EXT are used for search.
  330.     
  331.     C:\DIR\*.*                :    All files in the directory C:\DIR are used for
  332.                         search.
  333.     
  334.     [CDE]:\*.EXT    or
  335.     
  336.     [C-E]:\*.EXT            :    All files on the drives C:, D: and E: with the
  337.                                             extension .EXT are used for search.
  338.     
  339.     [C-E]:\*.[E?T|H]    :    All files on the drives C:, D: and E: with the
  340.                                             extension .E?T or .H are used for search. Up to
  341.                                             20 different extensions are possible, including
  342.                                             wildcards.
  343.  
  344. You can access the file selector by double clicking left or single
  345. clicking right in the source edit field to choose a path or a file.
  346.  
  347.  
  348. ∙Destination∙
  349.  
  350. GREPIT won't work without giving it a destination file for output.
  351. You have the following possibilities to specify the output file:
  352.  
  353.     C:\OUTPUT.DAT : The file OUTPUT.DAT is created on drive C:.
  354.     
  355.     OUTPUT.DAT    : The file OUTPUT.DAT is created in the current
  356.                     directory.
  357.     
  358.     CLIP          : The file SCRAP.TXT is created in the directory CLIPBRD
  359.                     on drive C:. If this directory doesn't exist yet,
  360.                     GREPIT creates it. Instead of CLIP you can also type
  361.                     CLIPBOARD or CLIPBRD (the case will be ignored). If
  362.                     there's no drive C:, the output file will be created
  363.                     on the drive where GREPIT has been started from.
  364.     
  365. You can access the file selector by double clicking left or single
  366. clicking right in the destination edit field to choose the destination
  367. file.
  368.  
  369. PAY ATTENTION NOW:
  370.  
  371.   GREPIT does not validate the destination file name for invalid
  372.   characters. Please use valid file names only!
  373.            
  374.            
  375. ∙Expression∙
  376.  
  377. GREPIT supports regular expressions known from UNIX operating systems.
  378. Regular expressions are specified by giving special meanings to some
  379. characters, like * or ? in command shells. For more details see "REGULAR
  380. EXPRESSIONS".
  381.  
  382. NOTE: There are two ways to make GREPIT search for several expressions
  383. at the same time: (Wow Wee Man)
  384.  
  385. 1. Use the OR symbol "|" to separate expressions in the input line.
  386.  
  387. 2. Write all expressions line by line into a file and use the extension
  388.    .GRE (GRepit Expressions) for it. Simply type the file's name in the
  389.    expression input line and then activate the switch "-f" in the
  390.    "Extended Options" dialog.
  391.    You can find some examples for expression files in the directory
  392.    GRE on the original disk.
  393.    An expression file may contain up to 256 lines with a maximum length
  394.    of 256 characters each.
  395.    
  396. You can access the file selector by double clicking left or single
  397. clicking right in the expression edit field to choose an expression
  398. file (the given default extension is set to .GRE).
  399.  
  400. Format of expression files:
  401.  
  402.  --------------------------------------------------------------------
  403.  Expression1
  404.  Expression2
  405.  Expression3|Expression4
  406.  ...
  407.  ...
  408.  ...
  409.  Expression256
  410.  --------------------------------------------------------------------
  411.  
  412.  
  413. ∙Options∙ (I think you understand this term)
  414.  
  415. -b (binary)   : Binary data is skipped. Know what I mean Vern?
  416.  
  417. -d (directory): The subdirectories of the given or current directory
  418.                 are also searched for.
  419.                 
  420. -e (extended) : Extended output format. The output file will have a
  421.                 short heading and a small statistic at the end (the
  422.                 heading at the beginning, of course!!!).
  423.  
  424. -i (ignore)   : Capital and small letters are not important. So don't
  425.                 worry, be happy!
  426.  
  427. -r (regular)  : Checked : The expression is interpreted as a regular
  428.                 expression.
  429.                 Not checked: The expression stays uninterpreted.
  430.  
  431.                 The OR character is reserved for separating expressions.
  432.                 If you want to search for this character, you must use
  433.                 a regular expression for it, which is: "\|".
  434.                 Example: You search for "||".
  435.                          Expression = "\|\|"
  436.                 (The chick translating doesn't get it either so
  437.                 forgetaboutit!)
  438.  
  439. -v (verbose)  : The output is "outputted" on the output device. Well,
  440.                 actually I just want to say the output that's on the
  441.                 output device is outputted, too. Get it, got it, good!
  442.                 I think I need a drink ...
  443.                 Hint: Aaaahhh hhhmmmmmm uuuuhhhhh ..... ??????
  444.  
  445.  
  446. Upper/Lower Context
  447.  
  448. Enter the number of lines you want to see above and below the actual
  449. line found.
  450.  
  451. You can access a bunch of additional options by using the [Extended
  452. Options] button in the main dialog or the menu item. For description
  453. see "EXTENDED OPTIONS".
  454.  
  455.  
  456. ∙The Popups∙ (what she likes most, and I'm not talkin' baseball, boys!)
  457.  
  458. For source, destination and expression there are two history buttons
  459. provided at the right:
  460.  
  461. Automatic history function:
  462.   The left button. Stores the last inputs automatically; up to 15 lines.
  463.  
  464. Manual (permanent) history function:
  465.   The right button. This popup contains input made by the user.
  466.   
  467. To store an entry into the permanent history popup, position the cursor
  468. onto source, destination or expression edit field and press the "Insert"
  469. key. Then just select a free entry in the popup.
  470.  
  471.  
  472. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  473.  
  474.  
  475. ≡'EXTENDED OPTIONS' DIALOG≡
  476.  
  477.  
  478. -a (append): The output is appended to the previous file. For the
  479.              meaning of "to append" we recommend Webster's.
  480.  
  481. -c (count) : Ok 1 2 3 4 5 6 7 8 9 10 ..... Now backwards! Only the total
  482.              number of found lines is shown.
  483.              Example:   C:\DIR\TEST.TXT
  484.                         15 matches.
  485.  
  486. -f (file)  : The expressions are taken from a seperate file. Write the
  487.              file name into the expression edit line and set this option
  488.              (for more details see "Examples, Tips and Tricks").
  489.  
  490. -g (grep)  : The match (in the output file) is included within the two
  491.              "Mark left/right" edit field strings.
  492.  
  493. -h (hide)  : Hide and seek? Return to count! The filename is hidden.
  494.              Useful for filtering text.
  495.              Attention: Option -h excludes the option -l. Logical,
  496.              ain't it?
  497.  
  498. -l (list)  : If there is a match you will ONLY get the filename.
  499.              Attention: Option -l excludes the option -h.
  500.  
  501. -m (more)  : Length, time and date of the file are added to the filename.
  502.  
  503. -n (number): The output lines start with the line number (the number in
  504.              the original file of course).
  505.              Example:
  506.                          123:  Output line.
  507.                          
  508.              With a double click on the line number you can jump right
  509.              into the original file to the according position (see "Use
  510.              of Output Window").
  511.  
  512. -p (point) : The output starts at the beginning of the match.
  513.              Example: Line read = "Have a nice day!"
  514.                       search for "nice"
  515.                       Output    = "nice day!"
  516.  
  517. -u (unix)  : We are not talking of unic's! It just means that all lines
  518.              in the output file end with LF only instead of CR/LF. That's
  519.              useful for transferring files to Unix systems (see Examples,
  520.              Tips and Tricks).
  521.  
  522. -w (word)  : There is a match only when the searched for expression is
  523.              found as a word, i.e. when the character before AND after
  524.              the expression is NOT out of [a-zA-Z0-9_].
  525.  
  526. -y (onlY)  : The output ends at the end of the match.
  527.              Example: Line read = "Have a nice day!"
  528.                       search for "nice"
  529.                       Output    = "Have a nice"
  530.                       
  531.              The combination of -p and -y gives you the match only.
  532.  
  533. -z (zero)  : All lines which do NOT contain the searched for expression
  534.              are written into the output file.
  535.  
  536.  
  537. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  538.  
  539.  
  540. ≡'SETTINGS' DIALOG≡
  541.  
  542.  
  543. Lines (max.):
  544.   Maximum number of lines the output window can display. If the file to
  545.   display is longer, GREPIT tries to adjust this value automatically -
  546.   but this will take time so we recommend to increase the value if
  547.   you have many long files. The number of lines, times 4 is the amount
  548.   of memory used (for example 6000 lines x 4 = 24000 bytes), because
  549.   GREPIT loads the files virtually (only pointers to lines) to display
  550.   also large files at low memory.
  551.   Remark: This value only concerns the files to be displayed in the
  552.   output window, not the files to be searched in (they may be of any
  553.   size).
  554.   
  555. Tab width:
  556.   Tab's are expandable.
  557.   
  558. Main dialog at program startup:
  559.   If you set this option the main dialog appears automatically after
  560.   the program starts. Look how much time we try to save you!
  561.   
  562. 3D effects:
  563.     The 3D effect can be activated on color resolutions with 16 or more
  564.     colors. If you can't deal with it, just shut it off ;-) !
  565.  
  566. Auto save settings:
  567.   The complete settings (input lines, history popups, window positions
  568.   etc.) are saved automatically every time you quit the program. A
  569.   highly recommended option!
  570.  
  571.  
  572. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  573.  
  574.  
  575. ≡'FONT' DIALOG≡
  576.  
  577.  
  578. You can choose the font and its size for the output and help window. If
  579. GDOS is installed, GDOS fonts (except proportional ones) are displayed
  580. and supported.
  581.  
  582. Hint: Not all GDOS fonts cantain all of the characters. But be opti-
  583. mistic - 10% of the characters aren't missing. You just have 90% to
  584. work with.
  585.  
  586.  
  587. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  588.  
  589.  
  590. ≡'COLORS' DIALOG≡
  591.  
  592.  
  593. I didn't know colors could talk. But in this case you can set the colors
  594. for window background, window text, paths, line numbers and expressions
  595. as well as the headlines in the help function.
  596.  
  597. In reference to colors... Welcome to the 90s. Don't breathe the air.
  598. Don't drink the water. Don't eat fruit, vegetables, meat, fish, sugar,
  599. salt, fats. Don't have sex ever again. No more monochrome resolutions.
  600. Have a nice day!
  601.  
  602. But we stay old fashioned by letting GREPIT work in monochrome. But
  603. invert found expressions.
  604.  
  605.  
  606. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  607.  
  608.  
  609. ≡'FIND' DIALOG≡
  610.  
  611.  
  612. Come on you know this one. Just enter the expression to be found in the
  613. output window ... The search always begins with the first visible line
  614. in the window.
  615.  
  616. If the expression is found, the line will be inverted. If no expression
  617. is entered, all find variables are reset, an inverted line disappears.
  618.  
  619. The options are common, too:
  620.  
  621.   [Backwards]:
  622.     Search to the beginning of the text. It's automatically switched
  623.     into this mode after reaching the end of the text.
  624.   [Ignore Case]:
  625.     Capital and small letters are ignored.
  626.   [Whole Word]:
  627.     There is a match only when the searched for expression is found as
  628.     a word.
  629.   [Regular Expression]:
  630.     The expression is interpreted as a regular expression.
  631.  
  632. You can repeat the search with >Control-G<. In this case search will be
  633. continued with the first visible line in the output window except there
  634. is a found line shown in the window. Then search goes on with the line
  635. after or before this line (depends on the last active search direction).
  636.  
  637.  
  638. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  639.  
  640.  
  641. ≡'MARK EXPRESSION' DIALOG≡
  642.  
  643.  
  644. The expression entered in this dialog is highlighted throughout the
  645. output window with the color you have set for expressions in the
  646. "Colors" dialog.
  647.  
  648. The options are:
  649.  
  650.   [Ignore Case]:
  651.     Capital and small letters are ignored.
  652.   [Regular Expression]:
  653.     The expression is interpreted as a regular expression.
  654.  
  655. After every grep process the first expression entered in the main
  656. dialog is marked automatically. This feature allows you to quickly
  657. make any expression in the output window visible without starting a
  658. new grep process.
  659.  
  660. If no expression is entered, no expression will be marked of course.
  661. Tah-Dah!
  662.  
  663.  
  664. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  665.  
  666.  
  667. ≡'PRINTER SETTINGS' DIALOG≡
  668.  
  669.  
  670. You can adjust GREPIT to your printer here. Please enter the values
  671. (escape sequences) in decimal numbers, separated by commas. The
  672. sequences in detail:
  673.  
  674. 'Description':
  675.     No special meaning, just for information.
  676. 'Init Text':
  677.     Sent to the printer before everything else. Normally used for
  678.     printer reset, font and line settings etc.
  679. 'Exit Text':
  680.     Sent at the end of printing. Used for form feed and printer reset.
  681. 'Init Page', 'Exit Page':
  682.     Sequence at every page start and end. The exit page sequence
  683.     (usually a form feed = 12) is sent after the number of lines
  684.     entered in 'Lines per page' edit field in the "Print" dialog.
  685.     If you, for example, don't set a form feed at 'Exit Page', the
  686.     value in 'Lines per page' has no effect.
  687. 'Init Line', 'Exit Line':
  688.     Sequence at every line start and end. For example 5 x the value 32
  689.     as init line makes a left border of 5 spaces. For line exit the
  690.     standard setting is normally '13,10' (13 = Carriage Return, 10 =
  691.     Line Feed).
  692.     
  693. The remaining 2x8 edit fields are for changing critical characters by
  694. replacing characters with printer sequences.
  695.  
  696. With [Load] and [Save] you can write (and read from) the printer setting
  697. to a separate file (default extension is *.DRV).
  698.  
  699.  
  700. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  701.  
  702.  
  703. ≡'PRINT' DIALOG≡
  704.  
  705.  
  706. Print the file presently shown in the output window. You can use the
  707. parallel or serial port. You can also set the number of lines per
  708. page and the number of characters per line.
  709.  
  710. Hint: If you don't set a form feed in the 'Exit Page' sequence of the
  711.       printer setting, the value in 'Lines per page' has no effect, i.e.
  712.       the printer ejects the paper by itself and you will always get the
  713.       maximum number of lines on a page.
  714.  
  715.  
  716. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  717.  
  718.  
  719. ≡REGULAR EXPRESSIONS≡
  720.  
  721.  
  722. Attention and concentration please, here comes the most difficult part
  723. of this manual. This is our implementation of Regular Expressions:
  724.  
  725.   ^      - The circumflex as the first character constrains matches to
  726.            the beginning of lines.
  727.            Ex.: 1) "^blahblah" matches lines beginning with "blahblah".
  728.                 2) "^" matches all non-blank lines.
  729.  
  730.   $      - The dollar sign as the last character constrains matches to
  731.            the end of lines.
  732.            Ex.: 1) "blahblah$" matches lines ending with "blahblah".
  733.                 2) "^blahblah$" matches lines consisting of the single
  734.                    word "blahblah".
  735.  
  736.   .      - The period represents any single character, like the DOS
  737.            wildcard "?".
  738.            Ex.: "Hun.er" matches "Hunter", "Hunger" etc.
  739.  
  740.   [a-z]  - Character group. Represents any character of this group or
  741.            of the given range of characters. Important: A range of
  742.            characters must be given in ASCII order (A-Z, a-z, 0-9 etc.).
  743.            Ex.: 1) "[0-9]" matches all digits from 0 to 9.
  744.                 2) "([0-9]+)" matches "(76)", "(56789)", "(4)" etc.
  745.                    (for the explanation of the "+" specifier read on)
  746.                 3) "^[A-Z]" matches lines starting with capital letters.
  747.  
  748.   [^a-z]  - Negative character group. Represents any character NOT in
  749.             this group or not in the given range of characters.
  750.             Ex.: "Gre[^py]" matches "Green", "Great" etc. but not
  751.                  "Grep", "Grey" etc.
  752.                  
  753.   ?       - The preceeding character or the preceeding character
  754.             group may occur 0 or 1 times. Not to be mistaken for the
  755.             DOS wildcard!
  756.             Ex.: "bla?hblah" matches "blhblah" or "blahblah" but not
  757.                  "blaahblah"
  758.  
  759.   *       - The preceeding character or the preceeding character
  760.             group may occur 0 or more times.
  761.             Ex.: "bla*hblah" matches "blhblah", "blahblah", "blaahblah"
  762.                  "blaaaahblah" and so on...
  763.  
  764.   +       - The preceeding character or the preceeding character
  765.             group may occur 1 or more times.
  766.             Ex.: "bla+hbla" matches "blahblah", "blaaaahblah" etc.
  767.             
  768.   \       - Quote next character. This allows all the above mentioned
  769.             regular expression specifiers to be searched for.
  770.             Ex.: If you want to search for "*" you have to write "\*".
  771.  
  772. ATTENTION: Search for line separator characters (Carriage Returns and/or
  773.            Line Feeds) is not yet supported at this time.
  774.  
  775.  
  776. Input of expressions:
  777.  
  778. You normally just enter the expression(s) in the "Expression(s)" edit
  779. field of the main dialog. But, for very long expressions or many of them
  780. you can use an external expression file. Write all expressions line by
  781. line into a file and use the extension .GRE (GRepit Expressions) for it.
  782. Simply type the file's name in the expression input line of the main
  783. dialog and activate the switch "-f" in the "Extended Options" dialog.
  784. An expression file may contain up to 256 lines with a maximum length
  785. of 256 characters each.
  786.  
  787.  
  788. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  789.  
  790.  
  791. ≡SPECIAL FEATURES≡
  792.  
  793.  
  794. ∙Messages from GREPIT to other programs∙
  795.  
  796. If you double click on a file name or file path with the right mouse
  797. button, GREPIT sends the message GM_SHOW_FILE (8000) to the main
  798. application.
  799.  
  800. For programmers:
  801.   pipe[0]             : contains the message ID 8000 (GM_SHOW_FILE).
  802.   pipe[3] und pipe[4] : contain a pointer to the file name.
  803.   pipe[5] und pipe[6] : contain the number of the line to be displayed,
  804.                         as a long value.
  805.  
  806.  
  807. ∙Messages from other programs to GREPIT∙
  808.  
  809. The above described procedure also works vice versa. If GREPIT receives
  810. the message GM_SHOW_FILE it will display the file.
  811.  
  812.  
  813. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  814.  
  815.  
  816. ≡EXAMPLES, TIPS AND TRICKS≡
  817.  
  818.  
  819. ∙Converting to and from UNIX∙
  820.  
  821. Problem : You have an ASCII file from a UNIX system. UNIX uses only a
  822.           LF (Line Feed) for terminating lines, but TOS normally needs
  823.           the CR/LF (Carriage Return / Line Feed) combination, therefore
  824.           you should convert the file.
  825. Solution: GREPIT can read both types of ASCII files but the output is
  826.           always in TOS format. Just enter the UNIX file name in the
  827.           'Source(s)' field, a different file name in the 'Destination'
  828.           field, use the regular expression ".*" which matches all lines
  829.           and disable all options except the "Regular Expression" option
  830.           in the main dialog.
  831. Example : Source(s)    :  C:\UNIX.TXT
  832.           Destination  :  C:\UNIX2TOS.TXT
  833.           Expression(s):  .*
  834.              
  835.  or
  836.  
  837. Problem : You want to transfer TOS ASCII files to UNIX systems.
  838. Solution: Do it like the above mentioned and set the flag -k in the
  839.           "Extended Options" dialog. This option lets GREPIT add
  840.           only LF instead of CR/LF to line endings.
  841.           
  842.  
  843. ∙Extracting of C-strings, comments, hex values or functions∙
  844.  
  845. Problem : You want to extract all strings out of a C-project and you
  846.           want to get the strings without the rest of the line.
  847. Solution: Use the regular expression >>>".*"<<< to find all lines
  848.           containing anything in quotation marks. To fade out the
  849.           rest of the line, set the options -p and -y in the "Extended
  850.           Options" dialog.
  851.  
  852.  or
  853.  
  854. Problem : You want to extract comments in a C-project.
  855. Solution: Use the regular expression >>>/\*.*\*/<<<. Remember: "*" is
  856.           a regular expression specifier and you must set a backslash
  857.           in front of it to be interpreted as a normal character!
  858. Suggest.: Begin your C-functions with a header, for example:
  859.           /*****************************************/
  860.           /* Function name: Description            */
  861.           /*****************************************/
  862.           Now you can extract these headers with the above regular
  863.           expression.
  864.  
  865.  or
  866.  
  867. Problem : You want to find all hexadecimal numbers in a C-project.
  868. Solution: Use the regular expression >>>0[xX][0-9a-fA-F]*<<<.
  869.  
  870.  or
  871.  
  872. Problem : You want to find all functions in a C-project.
  873. Solution: Use >>>^[a-zA-Z][a-zA-Z]* *.*([^;]*)[^;]*$<<<. Confused?
  874.  
  875.  
  876. ∙Search by using expression files (lists)∙
  877.  
  878. Problem : You want to extract all calls to GEMDOS functions in your
  879.           C-project.
  880. Solution: Write the names of all GEMDOS functions to a seperate text
  881.           file (for example GEMDOS.GRE) and set the flag -f in the
  882.           extended options dialog. GREPIT will search for all
  883.           expressions listed in this file.
  884.           
  885.           There are some sample files in the folder "GRE" of the
  886.           original GREPIT archive.
  887.  
  888.  
  889. ∙GREPIT as a file finder∙
  890.  
  891. Problem : You need to find a file on your harddisk but you can't
  892.           remember the exact name. The partitions on the harddisk are
  893.           C:, D:, E: and F:. The file name begins with "A" and has the
  894.           extension ".TXT".
  895. Solution: Source(s) : [CDEF]:\A*.TXT
  896.           Expression: .*
  897.           Flags to be set: -d Search subdirectories
  898.                            -l List only file names
  899.           (The regular expression ".*" matches anything.)
  900.           
  901.           To find all ".TXT", ".DOC" and ".TEX" files on drive C: enter:
  902.           Source(s) : C:\*.[TXT|DOC|TEX]
  903.           Expression: .*
  904.           Flags to be set: -d Search subdirectories
  905.                            -l List only file names
  906.  
  907.  
  908.                         ***   !!!   ***
  909. If you have more ideas to utilize GREPIT, let us know! We will collect
  910. and distribute them with GREPIT for the benefit of all GREPIT users.
  911.                         ***   !!!   ***
  912.  
  913.  
  914. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  915.  
  916.  
  917. ≡KEYBOARD SHORTCUTS≡
  918.  
  919.  
  920. ∙Basics∙
  921.  
  922. Basically all elements in a dialog box with a underlined character in
  923. the text can be selected by typing the underlined character combined
  924. with the 'Alternate' key on the keyboard.
  925. The button with the thick black border is the default button and can
  926. be selected by the Return/Enter key.
  927. A [Cancel] button corresponds with the 'Undo' key, a [?] button with
  928. the 'Help' key.
  929.  
  930.  
  931. ∙In the main dialog∙
  932.  
  933. 'Insert' : To store an entry into a permanent history popup.
  934.  
  935.  
  936. ∙In the output window∙
  937.  
  938. Arrow up                        :        scroll up
  939. Arrow down                    :        scroll down
  940. Arrow right                    :        scroll right
  941. Arrow left                    :        scroll left
  942. Shift and arrow keys:        page scroll
  943. ClrHome                            :        beginning of the file
  944. Shift-ClrHome                :        end of the file
  945. Control-ClrHome            :        adjust window size to maximum and back
  946. Control-F                        :        find expression in window
  947. Control-G                        :     repeat find
  948. Control-P                        :     print file
  949. Control-U                        :     close window
  950.  
  951.  
  952. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  953.  
  954.  
  955. ≡HELP ON HELP≡
  956.  
  957.  
  958. The help window can also be used with keyboard shortcuts:
  959.  
  960.     Arrow up                        :        scroll up
  961.     Arrow down                    :        scroll down
  962.     Arrow right                    :        scroll right
  963.     Arrow left                    :        scroll left
  964.     Shift and arrow keys:        page scroll
  965.     ClrHome                            :        beginning of chapter
  966.     Shift-ClrHome                :        end of chapter
  967.     Control-ClrHome            :        adjust window size to maximum and back
  968.     Undo                :   jump to contents
  969.  
  970. ESC, Control-Q, Control-U    or 2 x Undo:     Close help.
  971.  
  972. In the table of contents, a click with the left mouse button on a
  973. chapter headline displays the referring chapter. Return to contents
  974. with a right click anywhere in the help window.
  975.  
  976.  
  977. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  978.  
  979.  
  980. ≡GETTING REGISTERED≡
  981.  
  982.  
  983. The program GREPIT is used for pattern matching and string searching in
  984. files. Through the use of regular expressions GREPIT can provide you
  985. with search patterns however complex they may be. These patterns can be
  986. searched for in all types of files.
  987.  
  988. GREPIT also provides you with many options to vary or specify search
  989. and output. GREPIT is a powerful tool mainly for those who deal with
  990. many texts, as in the fields of software development or electronic mail
  991. /communication etc.
  992.  
  993. GREPIT lets you easily jump into (and back) the found files just by
  994. clicking on a file path or line number in the output window.
  995.  
  996. GREPIT is (or will soon be) available for various platforms in addition
  997. to Atari TOS as MS-DOS, MS Windows, Windows NT, OS/2, NeXTstep, Apple,
  998. Unix ...
  999.  
  1000. There are NO restrictions in unregistered state. Only the info dialog
  1001. will appear at every program startup as an evaluation copy reminder.
  1002.  
  1003.  
  1004.    ----------------------------------------------------------
  1005.                ∙REGISTRATION FEE:    US$ 20,--∙
  1006.    ----------------------------------------------------------
  1007.        or the equivalent amount in your local currency.
  1008.  
  1009.  
  1010. Follow these steps for registration:
  1011.  
  1012. 1) Send us the form ORDER.TXT (E-Mail, FAX or snail mail) with your
  1013.    adress and way of payment
  1014.    
  1015.    or
  1016.    
  1017.    You are a CompuServe member. Then just type GO SWREG and register
  1018.    online. Enter GREPIT's registration ID #3130 when prompted. The
  1019.    registration fee will be charged to your CompuServe account.
  1020.  
  1021. 2) After receiving your payment we will send you your serial number
  1022.    and registration code.
  1023.  
  1024. 3) Click on [Register!] in the "...about GREPIT" dialog and enter your
  1025.    name, serial number and registration code.
  1026.    
  1027.    
  1028. And here is our adress:
  1029.  
  1030.         MicroService Hermann Wierl
  1031.         Bahnhofstrasse 8
  1032.         93336 Altmannstein
  1033.         GERMANY
  1034.         MO-FR 9-12 a.m. and 2-5 p.m. CET
  1035.  
  1036.         Phone and FAX:  +49-9446-2149
  1037.         E-Mail: CompuServe 100345,2231
  1038.  
  1039. We can also be contacted via private E-Mail adresses:
  1040.   Hermann Wierl @ R          (MausNet Germany),
  1041.   Hermann Wierl @ 2:2494/315 (FidoNet),
  1042. which look like this as Internet adresses:
  1043.   hermann_wierl@r.maus.de
  1044.   hermann_wierl@f315.n2494.z2.fidonet.org
  1045.  
  1046.  
  1047. Please note: After successful registration a file named GREPIT.REG is
  1048. created with your data. Please don't include this file when copying
  1049. because it contains your personal data!
  1050.  
  1051.  
  1052. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1053.